3 * Factory for handling the special page list and generating SpecialPage objects.
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
21 * @ingroup SpecialPage
22 * @defgroup SpecialPage SpecialPage
25 namespace MediaWiki\Special
;
30 use MediaWiki\Config\ServiceOptions
;
31 use MediaWiki\Linker\LinkRenderer
;
39 * Factory for handling the special page list and generating SpecialPage objects.
41 * To add a special page in an extension, add to $wgSpecialPages either
42 * an object instance or an array containing the name and constructor
43 * parameters. The latter is preferred for performance reasons.
45 * The object instantiated must be either an instance of SpecialPage or a
46 * sub-class thereof. It must have an execute() method, which sends the HTML
47 * for the special page to $wgOut. The parent class has an execute() method
48 * which distributes the call to the historical global functions. Additionally,
49 * execute() also checks if the user has the necessary access privileges
50 * and bails out if not.
52 * To add a core special page, use the similar static list in
53 * SpecialPageFactory::$list. To remove a core static special page at runtime, use
54 * a SpecialPage_initList hook.
56 * @note There are two classes called SpecialPageFactory. You should use this first one, in
57 * namespace MediaWiki\Special, which is a service. \SpecialPageFactory is a deprecated collection
58 * of static methods that forwards to the global service.
60 * @ingroup SpecialPage
63 class SpecialPageFactory
{
65 * List of special page names to the subclass of SpecialPage which handles them.
66 * @todo Make this a const when we drop HHVM support (T192166). It can still be private in PHP
69 private static $coreList = [
70 // Maintenance Reports
71 'BrokenRedirects' => \BrokenRedirectsPage
::class,
72 'Deadendpages' => \DeadendPagesPage
::class,
73 'DoubleRedirects' => \DoubleRedirectsPage
::class,
74 'Longpages' => \LongPagesPage
::class,
75 'Ancientpages' => \AncientPagesPage
::class,
76 'Lonelypages' => \LonelyPagesPage
::class,
77 'Fewestrevisions' => \FewestrevisionsPage
::class,
78 'Withoutinterwiki' => \WithoutInterwikiPage
::class,
79 'Protectedpages' => \SpecialProtectedpages
::class,
80 'Protectedtitles' => \SpecialProtectedtitles
::class,
81 'Shortpages' => \ShortPagesPage
::class,
82 'Uncategorizedcategories' => \UncategorizedCategoriesPage
::class,
83 'Uncategorizedimages' => \UncategorizedImagesPage
::class,
84 'Uncategorizedpages' => \UncategorizedPagesPage
::class,
85 'Uncategorizedtemplates' => \UncategorizedTemplatesPage
::class,
86 'Unusedcategories' => \UnusedCategoriesPage
::class,
87 'Unusedimages' => \UnusedimagesPage
::class,
88 'Unusedtemplates' => \UnusedtemplatesPage
::class,
89 'Unwatchedpages' => \UnwatchedpagesPage
::class,
90 'Wantedcategories' => \WantedCategoriesPage
::class,
91 'Wantedfiles' => \WantedFilesPage
::class,
92 'Wantedpages' => \WantedPagesPage
::class,
93 'Wantedtemplates' => \WantedTemplatesPage
::class,
96 'Allpages' => \SpecialAllPages
::class,
97 'Prefixindex' => \SpecialPrefixindex
::class,
98 'Categories' => \SpecialCategories
::class,
99 'Listredirects' => \ListredirectsPage
::class,
100 'PagesWithProp' => \SpecialPagesWithProp
::class,
101 'TrackingCategories' => \SpecialTrackingCategories
::class,
104 'Userlogin' => \SpecialUserLogin
::class,
105 'Userlogout' => \SpecialUserLogout
::class,
106 'CreateAccount' => \SpecialCreateAccount
::class,
107 'LinkAccounts' => \SpecialLinkAccounts
::class,
108 'UnlinkAccounts' => \SpecialUnlinkAccounts
::class,
109 'ChangeCredentials' => \SpecialChangeCredentials
::class,
110 'RemoveCredentials' => \SpecialRemoveCredentials
::class,
113 'Activeusers' => \SpecialActiveUsers
::class,
114 'Block' => \SpecialBlock
::class,
115 'Unblock' => \SpecialUnblock
::class,
116 'BlockList' => \SpecialBlockList
::class,
117 'AutoblockList' => \SpecialAutoblockList
::class,
118 'ChangePassword' => \SpecialChangePassword
::class,
119 'BotPasswords' => \SpecialBotPasswords
::class,
120 'PasswordReset' => \SpecialPasswordReset
::class,
121 'DeletedContributions' => \DeletedContributionsPage
::class,
122 'Preferences' => \SpecialPreferences
::class,
123 'ResetTokens' => \SpecialResetTokens
::class,
124 'Contributions' => \SpecialContributions
::class,
125 'Listgrouprights' => \SpecialListGroupRights
::class,
126 'Listgrants' => \SpecialListGrants
::class,
127 'Listusers' => \SpecialListUsers
::class,
128 'Listadmins' => \SpecialListAdmins
::class,
129 'Listbots' => \SpecialListBots
::class,
130 'Userrights' => \UserrightsPage
::class,
131 'EditWatchlist' => \SpecialEditWatchlist
::class,
132 'PasswordPolicies' => \SpecialPasswordPolicies
::class,
134 // Recent changes and logs
135 'Newimages' => \SpecialNewFiles
::class,
136 'Log' => \SpecialLog
::class,
137 'Watchlist' => \SpecialWatchlist
::class,
138 'Newpages' => \SpecialNewpages
::class,
139 'Recentchanges' => \SpecialRecentChanges
::class,
140 'Recentchangeslinked' => \SpecialRecentChangesLinked
::class,
141 'Tags' => \SpecialTags
::class,
143 // Media reports and uploads
144 'Listfiles' => \SpecialListFiles
::class,
145 'Filepath' => \SpecialFilepath
::class,
146 'MediaStatistics' => \MediaStatisticsPage
::class,
147 'MIMEsearch' => \MIMEsearchPage
::class,
148 'FileDuplicateSearch' => \FileDuplicateSearchPage
::class,
149 'Upload' => \SpecialUpload
::class,
150 'UploadStash' => \SpecialUploadStash
::class,
151 'ListDuplicatedFiles' => \ListDuplicatedFilesPage
::class,
154 'ApiSandbox' => \SpecialApiSandbox
::class,
155 'Statistics' => \SpecialStatistics
::class,
156 'Allmessages' => \SpecialAllMessages
::class,
157 'Version' => \SpecialVersion
::class,
158 'Lockdb' => \SpecialLockdb
::class,
159 'Unlockdb' => \SpecialUnlockdb
::class,
161 // Redirecting special pages
162 'LinkSearch' => \LinkSearchPage
::class,
163 'Randompage' => \RandomPage
::class,
164 'RandomInCategory' => \SpecialRandomInCategory
::class,
165 'Randomredirect' => \SpecialRandomredirect
::class,
166 'Randomrootpage' => \SpecialRandomrootpage
::class,
167 'GoToInterwiki' => \SpecialGoToInterwiki
::class,
170 'Mostlinkedcategories' => \MostlinkedCategoriesPage
::class,
171 'Mostimages' => \MostimagesPage
::class,
172 'Mostinterwikis' => \MostinterwikisPage
::class,
173 'Mostlinked' => \MostlinkedPage
::class,
174 'Mostlinkedtemplates' => \MostlinkedTemplatesPage
::class,
175 'Mostcategories' => \MostcategoriesPage
::class,
176 'Mostrevisions' => \MostrevisionsPage
::class,
179 'ComparePages' => \SpecialComparePages
::class,
180 'Export' => \SpecialExport
::class,
181 'Import' => \SpecialImport
::class,
182 'Undelete' => \SpecialUndelete
::class,
183 'Whatlinkshere' => \SpecialWhatLinksHere
::class,
184 'MergeHistory' => \SpecialMergeHistory
::class,
185 'ExpandTemplates' => \SpecialExpandTemplates
::class,
188 'Booksources' => \SpecialBookSources
::class,
190 // Unlisted / redirects
191 'ApiHelp' => \SpecialApiHelp
::class,
192 'Blankpage' => \SpecialBlankpage
::class,
193 'Diff' => \SpecialDiff
::class,
194 'EditTags' => \SpecialEditTags
::class,
195 'Emailuser' => \SpecialEmailUser
::class,
196 'Movepage' => \MovePageForm
::class,
197 'Mycontributions' => \SpecialMycontributions
::class,
198 'MyLanguage' => \SpecialMyLanguage
::class,
199 'Mypage' => \SpecialMypage
::class,
200 'Mytalk' => \SpecialMytalk
::class,
201 'Myuploads' => \SpecialMyuploads
::class,
202 'AllMyUploads' => \SpecialAllMyUploads
::class,
203 'PermanentLink' => \SpecialPermanentLink
::class,
204 'Redirect' => \SpecialRedirect
::class,
205 'Revisiondelete' => \SpecialRevisionDelete
::class,
206 'RunJobs' => \SpecialRunJobs
::class,
207 'Specialpages' => \SpecialSpecialpages
::class,
208 'PageData' => \SpecialPageData
::class,
211 /** @var array Special page name => class name */
217 /** @var ServiceOptions */
224 * TODO Make this a const when HHVM support is dropped (T192166)
229 public static $constructorOptions = [
230 'ContentHandlerUseDB',
231 'DisableInternalSearch',
232 'EmailAuthentication',
234 'EnableJavaScriptTest',
240 * @param ServiceOptions $options
241 * @param Language $contLang
243 public function __construct( ServiceOptions
$options, Language
$contLang ) {
244 $options->assertRequiredOptions( self
::$constructorOptions );
245 $this->options
= $options;
246 $this->contLang
= $contLang;
250 * Returns a list of canonical special page names.
251 * May be used to iterate over all registered special pages.
255 public function getNames() : array {
256 return array_keys( $this->getPageList() );
260 * Get the special page list as an array
264 private function getPageList() : array {
265 if ( !is_array( $this->list ) ) {
266 $this->list = self
::$coreList;
268 if ( !$this->options
->get( 'DisableInternalSearch' ) ) {
269 $this->list['Search'] = \SpecialSearch
::class;
272 if ( $this->options
->get( 'EmailAuthentication' ) ) {
273 $this->list['Confirmemail'] = \EmailConfirmation
::class;
274 $this->list['Invalidateemail'] = \EmailInvalidation
::class;
277 if ( $this->options
->get( 'EnableEmail' ) ) {
278 $this->list['ChangeEmail'] = \SpecialChangeEmail
::class;
281 if ( $this->options
->get( 'EnableJavaScriptTest' ) ) {
282 $this->list['JavaScriptTest'] = \SpecialJavaScriptTest
::class;
285 if ( $this->options
->get( 'PageLanguageUseDB' ) ) {
286 $this->list['PageLanguage'] = \SpecialPageLanguage
::class;
288 if ( $this->options
->get( 'ContentHandlerUseDB' ) ) {
289 $this->list['ChangeContentModel'] = \SpecialChangeContentModel
::class;
292 // Add extension special pages
293 $this->list = array_merge( $this->list, $this->options
->get( 'SpecialPages' ) );
295 // This hook can be used to disable unwanted core special pages
296 // or conditionally register special pages.
297 Hooks
::run( 'SpecialPage_initList', [ &$this->list ] );
305 * Initialise and return the list of special page aliases. Returns an array where
306 * the key is an alias, and the value is the canonical name of the special page.
307 * All registered special pages are guaranteed to map to themselves.
310 private function getAliasList() : array {
311 if ( is_null( $this->aliases
) ) {
312 $aliases = $this->contLang
->getSpecialPageAliases();
313 $pageList = $this->getPageList();
318 // Force every canonical name to be an alias for itself.
319 foreach ( $pageList as $name => $stuff ) {
320 $caseFoldedAlias = $this->contLang
->caseFold( $name );
321 $this->aliases
[$caseFoldedAlias] = $name;
322 $keepAlias[$caseFoldedAlias] = 'canonical';
325 // Check for $aliases being an array since Language::getSpecialPageAliases can return null
326 if ( is_array( $aliases ) ) {
327 foreach ( $aliases as $realName => $aliasList ) {
328 $aliasList = array_values( $aliasList );
329 foreach ( $aliasList as $i => $alias ) {
330 $caseFoldedAlias = $this->contLang
->caseFold( $alias );
332 if ( isset( $this->aliases
[$caseFoldedAlias] ) &&
333 $realName === $this->aliases
[$caseFoldedAlias]
335 // Ignore same-realName conflicts
339 if ( !isset( $keepAlias[$caseFoldedAlias] ) ) {
340 $this->aliases
[$caseFoldedAlias] = $realName;
342 $keepAlias[$caseFoldedAlias] = 'first';
345 wfWarn( "First alias '$alias' for $realName conflicts with " .
346 "{$keepAlias[$caseFoldedAlias]} alias for " .
347 $this->aliases
[$caseFoldedAlias]
355 return $this->aliases
;
359 * Given a special page name with a possible subpage, return an array
360 * where the first element is the special page name and the second is the
363 * @param string $alias
364 * @return array Array( String, String|null ), or array( null, null ) if the page is invalid
366 public function resolveAlias( $alias ) {
367 $bits = explode( '/', $alias, 2 );
369 $caseFoldedAlias = $this->contLang
->caseFold( $bits[0] );
370 $caseFoldedAlias = str_replace( ' ', '_', $caseFoldedAlias );
371 $aliases = $this->getAliasList();
372 if ( !isset( $aliases[$caseFoldedAlias] ) ) {
373 return [ null, null ];
375 $name = $aliases[$caseFoldedAlias];
376 $par = $bits[1] ??
null; // T4087
378 return [ $name, $par ];
382 * Check if a given name exist as a special page or as a special page alias
384 * @param string $name Name of a special page
385 * @return bool True if a special page exists with this name
387 public function exists( $name ) {
388 list( $title, /*...*/ ) = $this->resolveAlias( $name );
390 $specialPageList = $this->getPageList();
391 return isset( $specialPageList[$title] );
395 * Find the object with a given name and return it (or NULL)
397 * @param string $name Special page name, may be localised and/or an alias
398 * @return SpecialPage|null SpecialPage object or null if the page doesn't exist
400 public function getPage( $name ) {
401 list( $realName, /*...*/ ) = $this->resolveAlias( $name );
403 $specialPageList = $this->getPageList();
405 if ( isset( $specialPageList[$realName] ) ) {
406 $rec = $specialPageList[$realName];
408 if ( is_callable( $rec ) ) {
409 // Use callback to instantiate the special page
411 } elseif ( is_string( $rec ) ) {
413 $page = new $className;
414 } elseif ( $rec instanceof SpecialPage
) {
415 $page = $rec; // XXX: we should deep clone here
420 if ( $page instanceof SpecialPage
) {
424 // It's not a classname, nor a callback, nor a legacy constructor array,
425 // nor a special page object. Give up.
426 wfLogWarning( "Cannot instantiate special page $realName: bad spec!" );
433 * Return categorised listable special pages which are available
434 * for the current user, and everyone.
436 * @param User $user User object to check permissions
438 * @return array ( string => Specialpage )
440 public function getUsablePages( User
$user ) : array {
442 foreach ( $this->getPageList() as $name => $rec ) {
443 $page = $this->getPage( $name );
444 if ( $page ) { // not null
445 $page->setContext( RequestContext
::getMain() );
446 if ( $page->isListed()
447 && ( !$page->isRestricted() ||
$page->userCanExecute( $user ) )
449 $pages[$name] = $page;
458 * Return categorised listable special pages for all users
460 * @return array ( string => Specialpage )
462 public function getRegularPages() : array {
464 foreach ( $this->getPageList() as $name => $rec ) {
465 $page = $this->getPage( $name );
466 if ( $page && $page->isListed() && !$page->isRestricted() ) {
467 $pages[$name] = $page;
475 * Return categorised listable special pages which are available
476 * for the current user, but not for everyone
478 * @param User $user User object to use
479 * @return array ( string => Specialpage )
481 public function getRestrictedPages( User
$user ) : array {
483 foreach ( $this->getPageList() as $name => $rec ) {
484 $page = $this->getPage( $name );
487 && $page->isRestricted()
488 && $page->userCanExecute( $user )
490 $pages[$name] = $page;
498 * Execute a special page path.
499 * The path may contain parameters, e.g. Special:Name/Params
500 * Extracts the special page name and call the execute method, passing the parameters
502 * Returns a title object if the page is redirected, false if there was no such special
503 * page, and true if it was successful.
505 * @param Title &$title
506 * @param IContextSource &$context
507 * @param bool $including Bool output is being captured for use in {{special:whatever}}
508 * @param LinkRenderer|null $linkRenderer (since 1.28)
512 public function executePath( Title
&$title, IContextSource
&$context, $including = false,
513 LinkRenderer
$linkRenderer = null
515 // @todo FIXME: Redirects broken due to this call
516 $bits = explode( '/', $title->getDBkey(), 2 );
518 $par = $bits[1] ??
null; // T4087
520 $page = $this->getPage( $name );
522 $context->getOutput()->setArticleRelated( false );
523 $context->getOutput()->setRobotPolicy( 'noindex,nofollow' );
525 global $wgSend404Code;
526 if ( $wgSend404Code ) {
527 $context->getOutput()->setStatusCode( 404 );
530 $context->getOutput()->showErrorPage( 'nosuchspecialpage', 'nospecialpagetext' );
536 // Narrow DB query expectations for this HTTP request
537 $trxLimits = $context->getConfig()->get( 'TrxProfilerLimits' );
538 $trxProfiler = Profiler
::instance()->getTransactionProfiler();
539 if ( $context->getRequest()->wasPosted() && !$page->doesWrites() ) {
540 $trxProfiler->setExpectations( $trxLimits['POST-nonwrite'], __METHOD__
);
541 $context->getRequest()->markAsSafeRequest();
545 // Page exists, set the context
546 $page->setContext( $context );
549 // Redirect to canonical alias for GET commands
550 // Not for POST, we'd lose the post data, so it's best to just distribute
551 // the request. Such POST requests are possible for old extensions that
552 // generate self-links without being aware that their default name has
554 if ( $name != $page->getLocalName() && !$context->getRequest()->wasPosted() ) {
555 $query = $context->getRequest()->getQueryValues();
556 unset( $query['title'] );
557 $title = $page->getPageTitle( $par );
558 $url = $title->getFullURL( $query );
559 $context->getOutput()->redirect( $url );
564 $context->setTitle( $page->getPageTitle( $par ) );
565 } elseif ( !$page->isIncludable() ) {
569 $page->including( $including );
570 if ( $linkRenderer ) {
571 $page->setLinkRenderer( $linkRenderer );
574 // Execute special page
581 * Just like executePath() but will override global variables and execute
582 * the page in "inclusion" mode. Returns true if the execution was
583 * successful or false if there was no such special page, or a title object
584 * if it was a redirect.
586 * Also saves the current $wgTitle, $wgOut, $wgRequest, $wgUser and $wgLang
587 * variables so that the special page will get the context it'd expect on a
588 * normal request, and then restores them to their previous values after.
590 * @param Title $title
591 * @param IContextSource $context
592 * @param LinkRenderer|null $linkRenderer (since 1.28)
593 * @return string HTML fragment
595 public function capturePath(
596 Title
$title, IContextSource
$context, LinkRenderer
$linkRenderer = null
598 global $wgTitle, $wgOut, $wgRequest, $wgUser, $wgLang;
599 $main = RequestContext
::getMain();
601 // Save current globals and main context
605 'request' => $wgRequest,
607 'language' => $wgLang,
610 'title' => $main->getTitle(),
611 'output' => $main->getOutput(),
612 'request' => $main->getRequest(),
613 'user' => $main->getUser(),
614 'language' => $main->getLanguage(),
616 if ( $main->canUseWikiPage() ) {
617 $ctx['wikipage'] = $main->getWikiPage();
622 $wgOut = $context->getOutput();
623 $wgRequest = $context->getRequest();
624 $wgUser = $context->getUser();
625 $wgLang = $context->getLanguage();
626 $main->setTitle( $title );
627 $main->setOutput( $context->getOutput() );
628 $main->setRequest( $context->getRequest() );
629 $main->setUser( $context->getUser() );
630 $main->setLanguage( $context->getLanguage() );
633 $ret = $this->executePath( $title, $context, true, $linkRenderer );
635 // Restore old globals and context
636 $wgTitle = $glob['title'];
637 $wgOut = $glob['output'];
638 $wgRequest = $glob['request'];
639 $wgUser = $glob['user'];
640 $wgLang = $glob['language'];
641 $main->setTitle( $ctx['title'] );
642 $main->setOutput( $ctx['output'] );
643 $main->setRequest( $ctx['request'] );
644 $main->setUser( $ctx['user'] );
645 $main->setLanguage( $ctx['language'] );
646 if ( isset( $ctx['wikipage'] ) ) {
647 $main->setWikiPage( $ctx['wikipage'] );
654 * Get the local name for a specified canonical name
656 * @param string $name
657 * @param string|bool $subpage
660 public function getLocalNameFor( $name, $subpage = false ) {
661 $aliases = $this->contLang
->getSpecialPageAliases();
662 $aliasList = $this->getAliasList();
664 // Find the first alias that maps back to $name
665 if ( isset( $aliases[$name] ) ) {
667 foreach ( $aliases[$name] as $alias ) {
668 $caseFoldedAlias = $this->contLang
->caseFold( $alias );
669 $caseFoldedAlias = str_replace( ' ', '_', $caseFoldedAlias );
670 if ( isset( $aliasList[$caseFoldedAlias] ) &&
671 $aliasList[$caseFoldedAlias] === $name
679 wfWarn( "Did not find a usable alias for special page '$name'. " .
680 "It seems all defined aliases conflict?" );
683 // Check if someone misspelled the correct casing
684 if ( is_array( $aliases ) ) {
685 foreach ( $aliases as $n => $values ) {
686 if ( strcasecmp( $name, $n ) === 0 ) {
687 wfWarn( "Found alias defined for $n when searching for " .
688 "special page aliases for $name. Case mismatch?" );
689 return $this->getLocalNameFor( $n, $subpage );
694 wfWarn( "Did not find alias for special page '$name'. " .
695 "Perhaps no aliases are defined for it?" );
698 if ( $subpage !== false && !is_null( $subpage ) ) {
699 // Make sure it's in dbkey form
700 $subpage = str_replace( ' ', '_', $subpage );
701 $name = "$name/$subpage";
704 return $this->contLang
->ucfirst( $name );
708 * Get a title for a given alias
710 * @param string $alias
711 * @return Title|null Title or null if there is no such alias
713 public function getTitleForAlias( $alias ) {
714 list( $name, $subpage ) = $this->resolveAlias( $alias );
715 if ( $name != null ) {
716 return SpecialPage
::getTitleFor( $name, $subpage );